IString Class Reference

Interface to a string of variable size and encoding. More...

#include <istringresult.h>

Inheritance diagram for IString:
Inheritance graph
[legend]

Public Member Functions

virtual void setText8 (const char8 *text)=0
 Assign ASCII string.
virtual void setText16 (const char16 *text)=0
 Assign unicode string.
virtual const char8getText8 ()=0
 Return ASCII string.
virtual const char16getText16 ()=0
 Return unicode string.
virtual void take (void *s, bool isWide)=0
 !Do not use this method! Early implementations take the given pointer as internal string and this will cause problems because 'free' will be used to delete the passed memory.
virtual bool isWideString () const =0
 Returns true if the string is in unicode format, returns false if the string is ASCII.

Static Public Attributes

static const FUID iid

Detailed Description

Interface to a string of variable size and encoding.

[host imp] or [plug imp]
[released: ]


Member Function Documentation

virtual void setText8 ( const char8 text  )  [pure virtual]

Assign ASCII string.

virtual void setText16 ( const char16 text  )  [pure virtual]

Assign unicode string.

virtual const char8* getText8 (  )  [pure virtual]

Return ASCII string.

If the string is unicode so far, it will be converted. So you need to be careful, because the conversion can result in data loss. It is save though to call getText8 if isWideString() returns false

virtual const char16* getText16 (  )  [pure virtual]

Return unicode string.

If the string is ASCII so far, it will be converted.

virtual void take ( void *  s,
bool  isWide 
) [pure virtual]

!Do not use this method! Early implementations take the given pointer as internal string and this will cause problems because 'free' will be used to delete the passed memory.

Later implementations will redirect 'take' to setText8 and setText16

virtual bool isWideString (  )  const [pure virtual]

Returns true if the string is in unicode format, returns false if the string is ASCII.


Field Documentation

const FUID iid [static]

Reimplemented from FUnknown.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
Empty

Copyright ©2013 Steinberg Media Technologies GmbH. All Rights Reserved.